home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / STVIEW10.ZIP / STARVIEW.DOC < prev    next >
Encoding:
Text File  |  1996-04-21  |  8.8 KB  |  214 lines
  1.                   StarView Archive Text File Snooper V1.0
  2.                            Public Domain Software
  3.               (!) 1996 Larry Monte/StarLab Systems Software
  4. -----------------------------------------------------------------------------
  5.  
  6. GUARANTEES:
  7. -----------
  8.               None expressed or implied. If StarView works for
  9.               you...great. If not, feel free to modify the code
  10.               to work on your system. 
  11. -----------------------------------------------------------------------------
  12.  
  13. What is StarView?:
  14. ------------------
  15.               StarView is a replacement for your VIEW_FILES command
  16.               in your MAX V3.x file area. It will not only show users
  17.               any text files contained on your system, but will also
  18.               allow them to snoop within archives for text files.
  19.               This is basically a stand-alone version of a feature
  20.               included in StarBar, a lightbar file selecting utility
  21.               released earlier.
  22. -----------------------------------------------------------------------------
  23.  
  24. OS/2 Sysops:
  25. ------------
  26.               Although I haven't heard of any problems with my
  27.               method of external archive snooping, they have
  28.               not been tested extensively on OS/2 systems.
  29.               My main concern is the *.CMD files which are used for
  30.               extracting files from within Archives. Because I have
  31.               no access to an OS/2 system, I could not test these
  32.               files properly.
  33.               I suspect they may work, but if they don't you will
  34.               have to modify the CMD files yourself.
  35.               Further, if you do get them to work (or the originals
  36.               work in the first place) please NetMail me the
  37.               corrections so I can include them in future releases!
  38.  
  39. -------------==============Basic Setup Instructions=============-------------
  40.  
  41. NOTE: I suggest everyone to setup StarView by the proceedures outlined below.
  42.       This will make it easier to track down problems if everyone uses the
  43.       program the same way.
  44.  
  45. 1) Make sure ALL your archivers are somewhere in your DOS path! You need to
  46.    do this for your daily BBS operations, so this _should_ be done already
  47.  
  48. 2) Make sure you have the MEX_INCLUDE environment set in your autoexec.bat
  49.    file. Your autoexec.bat should have this line:
  50.  
  51. SET MEX_INCLUDE=c:\max\m
  52.                 ^^^^^^^^^
  53.                 Should be set to where you keep your *.MH MEX files...
  54.  
  55.    If you don't have this set, add the above line to autoexec.bat and reboot
  56.    your computer!
  57.  
  58. 3) Unpack the STVIEW10.ZIP archive into a directory off your main BBS dir
  59.    called STARVIEW.
  60.    Here, it's : C:\MAX\STARVIEW
  61.  
  62.    NOTE: If you run StarBar V2.0 on your system, StarView will be quite
  63.          happy sharing that directory!
  64.  
  65. 4) MOVE (not copy) both STARVIEW.LH and STARVIEW.MH into your ..\m directory.
  66.    Here, it's : C:\MAX\M
  67.    Do not leave a copy of these files in the STARVIEW directory. Make sure
  68.    they are in your ..\m dir ONLY!
  69.  
  70. 5) Change to your ..\lang directory and load your main <language>.mad file
  71.    (here it's ENGLISH.MAD) into your favorite text editor.
  72.    NOTE: See below on creating other StarView language files for multiple
  73.          language systems.
  74.    At the end of your language file is a section called "User Heap". You
  75.    may see another include file there. Add the following to this section:
  76.  
  77. ; Include any user heaps here
  78.  
  79. <Other includes may be defined here>
  80. #include <../m/starview.lh>
  81.  
  82.    I know there is a USER.LH file where other language files can be defined
  83.    but to keep the least amount of confusion, put the above include line
  84.    in the main <language>.mad file.
  85.  
  86. 6) Compile your language file:
  87.  
  88. MAID <Your language here>.mad
  89.  
  90. 7) Change to your ..\m dir and load STARVIEW.MH into your favorite text
  91.    editor.
  92.    This file contains #defines that _MUST_ be changed before you compile
  93.    and run StarView.
  94.    The StarView.MH file contains all the information about how to change
  95.    the #defines. Just follow those and you should be okay.
  96.  
  97. 8) After you are finished with the MH file, change to the main StarBar
  98.    directory and compile StarView using:
  99.  
  100. MEX STARVIEW
  101.  
  102. 9) Make the following changes to your FILE SECTION in MENUS.CTL:
  103.  
  104.      MEX             StarView\StarView          Normal "View Text Files"
  105.      ^^^^^^^^
  106.         This replaces the FILE_VIEW entry in the FILE section.
  107.  
  108. 10) SILT MAX
  109.  
  110. 11) Run StarView on each node once. You need to do this once so StarView
  111.     can create a node-specific work directory.
  112.     StarView will report there are no Text or Doc files on the first run,
  113.     but will work fine after that.
  114.  
  115.     NOTE: This won't need to be done if you put StarView in the same dir
  116.           as StarBar (if you run StarBar) as you likely did this already
  117.           during the StarBar setup.
  118.  
  119. That's it. You should have a fully operational copy of StarView working on
  120. your BBS!
  121. -----------------------------------------------------------------------------
  122. ----------------------About the BAT/CMD/GUS/ACL Files------------------------
  123.  
  124. The distribution setup of StarView uses batch files which do the external
  125. archive snooping/unpacking. The current *.BAT *.CMD files will work without
  126. need of 3rd party utils. (You only need the archive programs themselves)
  127.  
  128. Included are *.GUS(DOS) & *.ACL(OS/2) files. These are included in case you
  129. wish to use GUS or ACLE to do your archive unpacking. In this case, simply
  130. rename the *.GUS (for DOS) files to *.BAT or *.ACL (for OS/2) files to *.CMD.
  131.  
  132. EG:(DOS)
  133.    You have UNPACK.BAT - Delete or rename this
  134.  
  135.             UNPACK.GUS - Copy or rename these to UNPACK.BAT
  136.  
  137.  
  138.    (OS/2)
  139.    You have UNPACK.CMD - Delete or rename this
  140.             
  141.             UNPACK.ACL - Copy or rename these to UNPACK.CMD
  142.  
  143. NOTE: If you use GUS or ACLE, they _MUST_ be in your main BBS directory, not
  144.       in the StarView dir!! (The *.BAT/*.CMD's should be in your StarView
  145.       directory)
  146.  
  147. NOTE: Both GUS and ALCE are requestable here @ 1:253/232 as "GUS" and
  148.       "ACLE"
  149. -----------------------------------------------------------------------------
  150. -------------------Adding/Modifying StarView Language Files------------------
  151.  
  152.   StarView is capable of using multiple language files. Once you have your
  153. primary language file using StarView.LH, you can copy this file to another
  154. name and include it in other language files.
  155.   However, if you don't have translated StarView language files, I recommend
  156. including StarView.LH in all your "user heaps" in all the language files
  157. you run.
  158.   If you have translated StarView language files, include the file in the
  159. appropriate language files.
  160.  
  161.   For instance, say you have a French language file for StarView called
  162. STARVFR.LH. Put it in your ..\m dir and include this filename in your
  163. french language "user heap". (Same method as described above)
  164.   MAID the French language file, and try it out. Run StarView under French
  165. and have a look.
  166.  
  167.  
  168.   Translating:
  169.   ------------
  170.  
  171.   Translating the StarView.LH file shouldn't prove to be too difficult, but
  172. there are a few things you should keep in mind:
  173.  
  174.   - Take care to preserve the control characters (EG: "\n\n") These are
  175.     line feed characters and may have undesired effects on other strings
  176.     if omitted.
  177.   - Make sure you don't touch the   =starview   statement which appears
  178.     after the version #define.
  179.   - Enclose all text in quotes (not the colour words)
  180.   - End each string with a   ;
  181.  
  182. -----------------------------------------------------------------------------
  183. ------------------------------Common Problems--------------------------------
  184.  
  185. Q: When I compile using "MEX STARVIEW", I get litterally _HUNDREDS_ of errors!
  186.  
  187. A: You either don't have "SET MEX_INCLUDE" defined in your AUTOEXEC.BAT file
  188.    or you've put the STARVIEW.MH file somewhere MEX can't see it. Make sure
  189.    STARVIEW.MH is in your ..\m directory, and that MEX_INCLUDE is defined
  190.    (see above or MAX.DOC on this) in AUTOEXEC.BAT.
  191.  
  192.  
  193. Q: MEX tells me that str_* variables aren't defined?
  194.  
  195. A: You either didn't include STARVIEW.LH in your <language>.mad file, or you
  196.    forgot to MAID it afterwards.
  197.  
  198.  
  199. Q: StarView always reports "Archive Contains No TXT or DOC files"?
  200.  
  201. A: Something is wrong with the external archive unpackers. Watch this
  202.    operation carefully and look for DOS error messages, such as "File
  203.    Not Found" or "Directory Doesn't Exist", etc.
  204.    NOTE: You will get this on the first run on each node.
  205.  
  206.  
  207. Q: When trying to use GUS or ACLE, I get "File Not Found" errors.
  208.  
  209. A: GUS or ACLE _MUST_ be in your main BBS directory, not the StarView dir.
  210.  
  211. -----------------------------------------------------------------------------
  212.  
  213. See Register.Doc for mailing information, if you need to contact me.
  214.